Include method names into headings in REST API documentation The headings for the REST endpoints contain currently only the URL path of the endpoint. Add also the method (e.g. GET) because one REST endpoint can accept different methods which provide different functionalities. The different functionalities should be described in own sections which is why it should be clear from the headings to which method a section relates. Change-Id: I4469d1448a62f48687945ba533e9f8002b9adff6 Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
diff --git a/Documentation/rest-api-projects.txt b/Documentation/rest-api-projects.txt index c259b9d..f5ab092 100644 --- a/Documentation/rest-api-projects.txt +++ b/Documentation/rest-api-projects.txt
@@ -8,8 +8,8 @@ Endpoints --------- -/projects/ (List Projects) -~~~~~~~~~~~~~~~~~~~~~~~~~~ +GET /projects/ (List Projects) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Lists the projects accessible by the caller. This is the same as using the link:cmd-ls-projects.html[ls-projects] command over SSH, and accepts the same options as query parameters. @@ -76,8 +76,8 @@ ---- E.g. this feature can be used by suggestion client UI's to limit results. -/projects/*/dashboards/ (List Dashboards) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +GET /projects/*/dashboards/ (List Dashboards) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ List custom dashboards for a project. The `/projects/{name}/dashboards/` URL expects the a URL encoded 